//=============================================================================================================
/**
 * @file     selectionscene.h
 * @author   Lorenz Esch <lesch@mgh.harvard.edu>;
 *           Christoph Dinh <chdinh@nmr.mgh.harvard.edu>
 * @version  dev
 * @date     October, 2014
 *
 * @section  LICENSE
 *
 * Copyright (C) 2014, Lorenz Esch, Christoph Dinh. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 * the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
 *       the following disclaimer in the documentation and/or other materials provided with the distribution.
 *     * Neither the name of MNE-CPP authors nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * @brief    Contains the declaration of the SelectionScene class.
 *
 */

#ifndef SELECTIONSCENE_H
#define SELECTIONSCENE_H

//*************************************************************************************************************
//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "../../disp_global.h"
#include "layoutscene.h"


//*************************************************************************************************************
//=============================================================================================================
// Eigen INCLUDES
//=============================================================================================================


//*************************************************************************************************************
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================


//*************************************************************************************************************
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================


//*************************************************************************************************************
//=============================================================================================================
// DEFINE NAMESPACE DISPLIB
//=============================================================================================================

namespace DISPLIB
{


//*************************************************************************************************************
//=============================================================================================================
// DISPLIB FORWARD DECLARATIONS
//=============================================================================================================


//=============================================================================================================
/**
 * DECLARE CLASS SelectionScene
 *
 * @brief The SelectionScene class provides a reimplemented QGraphicsScene for 2D layout plotting.
 */
class DISPSHARED_EXPORT SelectionScene : public LayoutScene
{
    Q_OBJECT

public:
    typedef QSharedPointer<SelectionScene> SPtr;              /**< Shared pointer type for SelectionScene. */
    typedef QSharedPointer<const SelectionScene> ConstSPtr;   /**< Const shared pointer type for SelectionScene. */

    //=========================================================================================================
    /**
     * Constructs a SelectionScene.
     */
    explicit SelectionScene(QGraphicsView* view, QObject *parent = 0);

    //=========================================================================================================
    /**
     * Updates layout data.
     *
     * @param [in] layoutMap layout data map.
     * @param [in] bad channel list.
     */
    void repaintItems(const QMap<QString, QPointF> &layoutMap,
                      QStringList badChannels);

    //=========================================================================================================
    /**
     * Hides all items described in list.
     *
     * @param [in] list string list with items name which are to be hidden.
     */
    void hideItems(QStringList visibleItems);

    int         m_iChannelTypeMode;     /**< The channel type mode. */
};

} // NAMESPACE DISPLIB

#endif // SelectionScene_H
